Add Biller

Allows an end user to add a biller.

Endpoint

Method: POST
URL: {{URL}}/PL/jsonrpc

Headers

Key	Type	Required	Description
Content-Type	string	Yes	application/json

---

Request

{
    "method": "BillpayConnectorService.AddBiller",
    "id": "1",
    "params": {
        "payload": {
            "accountNumber": "200213493088644",
            "consumerAccountNumber": "374322123456789",
            "billerAddress": {
                "addressLine1": "435 LAWRENCE BELL DR",
                "city": "Buffalo",
                "country": "USA",
                "state": "NY",
                "type": "Standard",
                "zipCode": "14221-8440"
            },
            "billerClass": "Security Systems / Monitoring Services",
            "billerId": "2786500317",
            "billerName": "AMHERST ALARM",
            "billerType": "Core",
            "billerMask": {
                "maskFormat": "@@@@@@@@@@@@@@@",
                "maskLength": "15",
                "maskRejex": "[0-9A-Z]{15}"
            }
        },
        "api": {
            "credential": "Basic bS5rdW1hcisxQG5ldHhkLmNvbToyYjVlMDIzMDg1NjU0YTE3ODUwZWE0N2Q1NWFlNWViNA==",
            "signature": "MEUCIEIL1PLI1j5IvZjPqa+5cgWkohSaRMPgtY/4RIJGMf/BAiEA47SUNIEzKSIlfgT3/ShMw6eM+AOg2HNDt61vjx8hQ/s=",
            "keyId": "231008"
        }
    }
}

Response: 200

Request Parameters

Parameter	Description
method Mandatory	String API method name Constant : billpayConnectorService.AddBiller
id Mandatory	String Unique ID for Request
accountNumber Mandatory	String Customer account number
consumerAccountNumber Mandatory	String Biller consumer number
billerAddress Optional	String Biller address
billerClass Mandatory	String Biller class
billerId Mandatory	String Biller ID
billerName Mandatory	String Biller name
billerMask. maskFormat Mandatory	String Mask format of consumer number
billerMask. maskLength Mandatory	String Mask format consumer number length
billerMask. maskRejex Mandatory	String Regex pattern of consumer number
credential Mandatory	String API credential for authentication
signature Mandatory	String Signature for request validation
keyId Mandatory	String Key ID for authentication

{
    "id": "1",
    "result": {
        "status": "PENDING APPROVAL",
        "message": "Waiting For Biller Approval",
        "ID": "4377077"
    },
    "jsonrpc": "2.0"
}